home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d8 / t3tools.arc / T3TOOLS.DOC < prev   
Text File  |  1991-03-24  |  26KB  |  448 lines

  1. Telix 3 Tools - (C) 1988 Robert Hoffmann
  2.                          76-53 271 Street
  3.                          New Hyde Park, NY 11040
  4.  
  5. Note: this file is not set up in pages.  You may wish to run it through a
  6.       word processor and page it out before printing it.
  7.  
  8. The author can be contacted by mail, or via the White Tiger PCBoard BBS at
  9. 1-718-962-2628 (PCPursuit via 212 node).
  10. --------------------------------------------------------------------------------
  11. The legalities
  12. --------------
  13. As far as I know, this set of programs does exactly what I claim it will do.
  14. However, I am definitely NOT guaranteeing that.  You are using the package
  15. entirely at your own risk.  If it does cause problems that appear to be
  16. program related, contact me at the BBS number above.  Please cage and
  17. forward any error messages or other manifestations of the errors.
  18. My address is supplied at the beginning and end of this document.
  19.  
  20. This is NOT a free, or public domain, package.  This is shareware.  In order
  21. for you to be using the package legally, you must register the program with
  22. me.  The registration details are explained later in this document.
  23.  
  24. No changes, revisions, deletions, or additions to this package may be made by
  25. anyone but the author.  If you have an idea on how I can make this package
  26. better, write me.  Don't patch files.  I will not be responsible for, nor can
  27. I support, other people's modifications.
  28.  
  29. Third-party shareware distributors (BBSes, user groups, etc.) may distribute
  30. this package freely, as long as they do not charge a fee which is more than
  31. their cost of distribution.  The author is the only person authorized to make
  32. a profit on this package.
  33.  
  34. I retain all copyrights to this program.
  35. --------------------------------------------------------------------------------
  36. The package
  37. -----------
  38. ...consists of five short executable programs.  They are:
  39.                 T3DARWIN.EXE - program to adapt Darwin BBS lists to Telix 3.xx.
  40.                 T3EDIT.EXE   - program to edit Telix 3.xx dialing directories.
  41.                 T3GLOBAL.EXE - program to globally change all entries in a
  42.                                Telix 3.xx dialing directory.
  43.                 T3PRINT.EXE  - program to print some or all of the data in a
  44.                                Telix 3.xx dialing directory.
  45.                 T3SORT.EXE   - program to sort a Telix 3.xx dialing directory
  46.                                on one of several key fields.
  47.  
  48. There should also be two other files in the package:
  49.                 T3TOOLS.DOC  - which you are now reading.
  50.                 $TOC         - which is a PKUNPAK (tm) view of the Telix 3
  51.                                Tools package.  If you suspect you have a
  52.                                corrupted (or illegally modified) archive, run
  53.                                PKUNPAK -v and save the output.  Then send me
  54.                                both your output and $TOC.  I can use the two
  55.                                files to verify your copy of the package.
  56.  
  57. It's designed for IBM PC's and close compatibles.  It uses the DOS and CRT
  58. units of Borland's Turbo Pascal 5.0 (tm).  If your computer cannot run TP5
  59. programs, these won't work, either.  Otherwise, you should have no problems.
  60. --------------------------------------------------------------------------------
  61. Assumption
  62. ----------
  63. If you do not have Telix 3.00, 3.10, or 3.11 (tm) (and if you have any,
  64. it should be version 3.11), this package is useless to you.  Therefore, I
  65. am going to assume you have Telix 3.xx, and know a little about it.
  66. --------------------------------------------------------------------------------
  67. --------------------------------------------------------------------------------
  68. Usage
  69. -----
  70. I have tried to make the programs as self-documenting as possible.  Entering
  71. the program name alone (or with only the /H switch) on the command line will
  72. give you a short help screen.
  73. --------------------------------------------------------------------------------
  74. 0. Syntax
  75.  
  76.    InFile  -- the input file for that program.
  77.    OutFile -- the output file for that program.
  78.    [stuff] -- bracketed selections are optional.
  79.    stuff   -- non-bracketed selections MUST be provided or the program will
  80.               abort.
  81.    <key>   -- the keyboard keys to hit when needed.
  82. --------------------------------------------------------------------------------
  83. 1. T3PRINT
  84.    Command line: T3PRINT [/op] InFile [OutFile]
  85.  
  86.    [/op] - A slash, followed by up to five option letters from the following
  87.            list:
  88.  
  89.            [DEFAULT: Standard data shown.  See 'OutFile' below for what is
  90.                      displayed and its format]
  91.  
  92.            H - show help screen [must be only option, remainder of command
  93.                                  line is ignored].
  94.            A - use all extra options [must be only option].
  95.  
  96.            C - show date of last call and number of calls.
  97.            P - show passwords.  This is optional so that you don't
  98.                accidentally give all your passwords to your best friend
  99.                when you give him/her your list of numbers.
  100.            T - show the settings for the five (or four in Telix 3.00) toggle
  101.                switches.  The output in this column is a 10-character string.
  102.                Decoding the toggle string:
  103.                Option: 1 2 3 4 5
  104.                  True: HiDlNoLfFd
  105.                 False: --BsDe--Hd
  106.                1 - Strip High Bit: 'Hi' means high-bit stripping is on.
  107.                    '--' means it's off (for Telix 3.00 directories, this
  108.                    should always be off).
  109.                2 - BS key sends: 'Dl' means Delete (ASCII 127).  'Bs' means
  110.                    Backspace (ASCII 8).
  111.                3 - BS translation: 'No' means non-destructive (cursor left),
  112.                    'De' means destructive backspace (backspace key).
  113.                4 - Add line feeds: 'Lf' means line feeds are added. '--'
  114.                    means they're not.
  115.                5 - Local echo: 'Fd' means Full Duplex (local echo off). 'Hd'
  116.                    means Half Duplex (local echo on).
  117.            S - show linked script names for each BBS.
  118.            M - show the default terminal type for each BBS.
  119.  
  120.    InFile - the Telix 3.xx dialing directory you want printed.  InFile must
  121.             exist, and exactly as shown.  If you are running T3PRINT from a
  122.             different directory than the .FON file, specify a full enough
  123.             pathname for the program to find it.  If the dialing directory
  124.             cannot be found, the program will abort.
  125.  
  126.    [OutFile] - the file which will receive the list.  If not specified, it
  127.                will be 'standard output' -- which means the output could be
  128.                redirected to another program.  For example, you could use
  129.                Vern Buerg's LIST (tm) to view the output as part of a pipe:
  130.                     T3PRINT /A TELIX.FON | LIST /S
  131.                would allow you to see a full printout of TELIX.FON without
  132.                permanently tying up disk space.
  133.  
  134.                If OutFile is a disk file, and it exists, it will be appended
  135.                to.  Otherwise, it will be created (if possible).
  136.  
  137.                The output file format, without any options, shows the dialing
  138.                directory entry number, name, phone number, baud, data bits,
  139.                parity, stop bits, default transfer protocol, and dialing
  140.                prefix across the page from left to right.  The additional
  141.                fields are added from left to right in the order shown above.
  142. --------------------------------------------------------------------------------
  143. 2. T3SORT
  144.    Command line: T3SORT [/op] InFile [OutFile]
  145.  
  146.    [/op] - A slash, followed by up to two option letters from the following
  147.            list:
  148.  
  149.            [DEFAULT: /A]
  150.  
  151.            H - show help screen [must be only option, remainder of command
  152.                                  line is ignored].
  153.  
  154.            A - sort the InFile by BBS name, in A-to-Z (ascending) order.
  155.            C - sort the InFile by last call date, most recent going first and
  156.                the ones you've never called going last.  The secondary sort
  157.                key is the total calls field.
  158.            D - sort the InFile by BBS name, in Z-to-A (descending) order.
  159.            L - sort the InFile by the BBS's 7-digit local number, in ascending
  160.                order.  The program skips embedded long distance prefixes.  For
  161.                this option to work correctly, numbers outside your area code
  162.                must start with the sequence '1-xxx' (where xxx is the other
  163.                area code) or a long distance prefix.
  164.            N - sort the InFile by the Phone Number field.  This will sort
  165.                based on whatever the first character of the phone number is.
  166.            T - sort the InFile by the total number of calls made, in descending
  167.                order.  The secondary sort key is the BBS Name field.
  168.  
  169.            F - the OutFile will be overwritten without confirmation if you
  170.                use this switch.  If you leave this out, and the OutFile exists,
  171.                you will be asked at run-time to confirm that you really do
  172.                want to do this.  If you choose not to overwrite the OutFile,
  173.                you can specify another filename -- which will also be checked
  174.                and verified if necessary.
  175.  
  176.    InFile - the Telix 3.xx dialing directory you are sorting.  See the 'InFile'
  177.             entry under 'T3PRINT' above for pathname rules.
  178.  
  179.    [OutFile] - the sorted Telix 3.xx dialing directory you are creating.  If
  180.                an OutFile is not specified, the InFile will also be the
  181.                OutFile.  See the 'F' switch above for how the OutFile is
  182.                handled if it already exists.
  183. --------------------------------------------------------------------------------
  184. 3. T3EDIT
  185.    Command line: T3EDIT [/H] [/F] InFile [OutFile]
  186.  
  187.    [/H] - show help screen.  Do not enter any other command line data, as it
  188.           is ignored.
  189.    [/F] - force OutFile to be overwritten regardless of its prior existence.
  190.    InFile - the Telix 3.xx dialing directory you are editing.  See the
  191.             'InFile' entry under 'T3PRINT' above for pathname rules.  For this
  192.             program, however, a non-existent InFile yields a one-blank-entry
  193.             OutFile.  This allows you to create new dialing directories with
  194.             T3EDIT.
  195.    [OutFile] - the edited Telix 3.xx dialing directory.  If OutFile is not
  196.                specified, it is assumed to be InFile.  If OutFile already
  197.                exists, and you don't force an overwrite with /F, you will
  198.                be asked to confirm that you really wanted to do that.
  199.  
  200.    What to do when the program is running:
  201.    The menu and display is all on one screen.  The top line shows the number
  202.    of records in the file, as well as the number of the current record.
  203.    All commands and menu entries are one-key entries.  That's why the menu
  204.    letters down the left side of the screen jump around a bit -- the commands
  205.    are designed to be as obvious as possible.  Requests for data or keystrokes
  206.    are displayed on line 24 of your screen (one line above the bottom of a
  207.    CGA/MDA screen).  The valid choices for T3EDIT are the letters A to S,
  208.    X to Z, and the <#> key:
  209.    [NOTE 1: I have not been able to design a good interactive edit in Pascal.
  210.             Therefore, you'll have to completely re-type any entries that
  211.             require text.  Sorry about that, Chief (oops).  I hope to have
  212.             this fixed for future Telix Tools releases.]
  213.    [NOTE 2: Items A to J, and the <#> key, can be aborted by pressing the
  214.             <ENTER> key immediately when asked for data on line 24.  The
  215.             field will then be left unchanged.]
  216.    [NOTE 3: You will be asked to confirm that you want to leave no matter
  217.             which flavor of exit command you use.  This is for your own
  218.             protection.  Confirmation prompts take <Y> or <N> only.]
  219.         <A> - BBS Name: You then type in the new name for this BBS.  There
  220.               is a 25-character limit.
  221.         <B> - Number: You then type in the phone number.  You can enter long
  222.               distance prefixes and postfixes, if you wish.  There is a 17-
  223.               character limit.
  224.         <C> - Settings: You'll see a menu across line 24.  Unfortunately, I
  225.               had to abbreviate baud rates due to space limitations.  From
  226.               left to right they are: 300, 1200, 2400, 4800, 9600, 19200,
  227.               38400, 57600, 115200 baud.  Hit the number key corresponding
  228.               to the baud rate desired.  Then key in the data, parity, and
  229.               stop bit information (<8><N><1>, for example).
  230.         <D> - Password: You then type in a new 14-character-or-less password.
  231.         <E> - Script: You then type in a new 12-character-or-less logon script
  232.               name.
  233.         <F> - Last Call: You then type in the date of your last call.  It MUST
  234.               be in the format 'MM/DD/YY' (or whatever order you use).  There
  235.               must be numbers in positions 1, 2, 4, 5, 7 and 8 in the
  236.               8-character field.
  237.         <G> - Total Calls: Enter the number of calls made.
  238.         <H> - Terminal: Select the terminal type from the menu on line 24.
  239.         <I> - Protocol: Enter one character for your default protocol.  The
  240.               character is not checked as I don't know your external protocol
  241.               situation.
  242.         <J> - Dialing Pre: Enter a number from 1 to 3 for the dialing prefix
  243.               you are using.
  244.         <K> - Strip HiBit: This is a toggle for the Strip High Bit setting.
  245.               TRUE means Strip High Bit is ON, FALSE means OFF.
  246.         <L> - BS/Delete: This is a toggle for the BS Key Sends setting.
  247.         <M> - BS Trans: This is a toggle for the BS Translation setting.
  248.         <N> - COMMAND: Next Record: Moves you forward one record in the file.
  249.               If you're on the final record, you circle around to record #1.
  250.         <O> - Add LFs: This is a toggle for the Add Line Feeds setting.
  251.               TRUE means Add Line Feeds is ON, FALSE means OFF.
  252.               It is the letter <O>, not the numeral <0>.
  253.         <P> - COMMAND: Previous Record: Moves you back one record in the file.
  254.               If you're on the first record, you circle back to the last one.
  255.         <Q> - COMMAND: Quit without changes: Allows you to leave the file
  256.               unchanged.  Use this if you really screw up the works and want
  257.               to try again.
  258.         <R> - Duplex: This is a toggle for the Local Echo setting.  'Full'
  259.               duplex means Local Echo is OFF, 'Half' Duplex means Local Echo
  260.               is ON.
  261.         <S> - COMMAND: Save without deleting: Allows you to save the entire
  262.               file whether or not you have tagged anything for deletion.  The
  263.               delete markers are not saved, so use this only if you're sure
  264.               you want to keep deleted fields.
  265.         <X> - COMMAND: Exit and delete: Saves all records except those you
  266.               mark for deletion (see <Z>).  Deleted records cannot be
  267.               recovered once you end the program.
  268.         <Y> - COMMAND: Add a record: Appends a blank record to the file, and
  269.               places you on it for editing.
  270.         <Z> - COMMAND: Mark for deletion: If FALSE appears here, the record
  271.               will be kept.  If TRUE appears here, and you end the program
  272.               with the <X> command, this record will be erased.  Delete flags
  273.               are not saved at exit.
  274.         <#> - COMMAND: Jump to number: You'll be asked to enter the number
  275.               of the record to move to.  An out of range number will be
  276.               corrected to the nearest end of the file.
  277. --------------------------------------------------------------------------------
  278. 4. T3GLOBAL
  279.    Command line: T3GLOBAL [/H | InFile]
  280.  
  281.    [/H] - show help screen.  Do not include a filename if you are asking for
  282.           help; it will be ignored.
  283.    InFile - the Telix 3.xx dialing directory you are updating.  See the
  284.             'InFile' entry under 'T3PRINT' above for pathname rules.
  285.  
  286.    What to do when the program is running:
  287.    Once the program is going, you get a simple menu screen with lettered
  288.    choices.  Hitting the letter on the keyboard activates a choice.  Whatever
  289.    information you need will be shown on line 24 of your screen (the next-to-
  290.    last line of a standard CGA/MDA screen).  If 'No change' appears next to an
  291.    entry, that means T3GLOBAL will not change that area of any directory
  292.    record.  If anything else appears, ALL of your directory records will be
  293.    changed to that setting.  If you have set a global change, and you'd like
  294.    to delete it -- hit the same letter key again.  If you are asked for more
  295.    information, hit <ENTER>.  This will (eventually) clear away any errant
  296.    settings.  The valid choices for T3GLOBAL are the letters A through L,
  297.    and Q:
  298.         <A> - Line settings:  When you hit <A>, a one-line menu pops up on
  299.               line 24 -- hit the number key indicating the baud rate you wish
  300.               to change to, or the <ENTER> key to clear a previous setting.  If
  301.               you choose a baud rate, you'll also have to choose global settings
  302.               for data, parity, and stop bit information.  You cannot change the
  303.               baud rate globally without changing the remaining line setting
  304.               information.
  305.         <B> - Call data:  This is a toggle between 'No change' and 'To be
  306.               cleared'.  If 'To be cleared' appears here, the date of your last
  307.               call and the total number of calls made will be erased in every
  308.               record of your dialing directory.
  309.         <C> - Password: Similar to <B>, for Password field.
  310.         <D> - Script: Similar to <B>, for Logon Script field.
  311.         <E> - Term Type: The menu that comes up on line 24 shows the
  312.               available terminal types.  Hit the number key corresponding to
  313.               the global terminal type you want, or <ENTER> to reset the
  314.               field.
  315.         <F> - Protocol: You then enter one character as your global protocol
  316.               choice.  <ENTER> clears away a prior choice, otherwise the
  317.               character is not checked as I don't know whether you have any
  318.               external protocols set up.
  319.         <G> - Dial Pref: You then enter a number from 1 to 3 as your global
  320.               dialing prefix, or <ENTER> to reset the field.
  321.         <H> - Strip Hi: A three-way toggle for the Strip High Bit field.  It
  322.               can say 'No change' (which leaves the field alone), 'forced
  323.               TRUE' (which sets the field to TRUE for all records), or 'forced
  324.               FALSE' (which sets the field to FALSE).  Hitting the <H> key
  325.               several times will cycle through the toggle until you reach
  326.               the one you want.
  327.         <I> - BS or Del: Similar to <H>, for the BS Key Sends field.
  328.         <J> - BS Trans: Similar to <H>, for the BS Translation field.
  329.         <K> - Add LF: Similar to <H>, for the Add Line Feeds field.
  330.         <M> - Duplex: Similar to <H>, for the Local Echo field.  'Full' Duplex
  331.               is equivalent to Local Echo OFF, 'Half' Duplex to Local Echo ON.
  332.         <Q> - COMMAND: Quit: Processes all global changes.  There is no
  333.               confirmation, so check the screen VERY carefully before hitting
  334.               <Q>uit.
  335. --------------------------------------------------------------------------------
  336. 5. T3DARWIN
  337.    Command line: T3DARWIN [/H] [/F] InFile OutFile
  338.  
  339.    [/H] - show help screen.  All other command line information is ignored.
  340.    [/F] - force OutFile to be overwritten without confirmation.
  341.    InFile - must be a valid Darwin BBS text file.  This program was written
  342.             based on the format of USBBS54.LST (November, 1988 edition).
  343.    OutFile - will be a Telix 3.xx dialing directory.  If OutFile exists, and
  344.              you have not specified /F (force) mode, you'll be asked to
  345.              confirm that you want to overwrite the OutFile, or change the
  346.              name of the OutFile.
  347.  
  348.    What to do when the program is running:
  349.    Due to the enormous size of the Darwin list, some screening is required
  350.    to get the dialing directory down to a manageable size.  There are three
  351.    criteria used to screen the list.  The program accepts them from standard
  352.    input, which means you can redirect the input from a text file (it's
  353.    recommended you use the /F switch so that your redirection script doesn't
  354.    get loused up).
  355.  
  356.    1. Area code: Enter (one at a time) each area code you want included in
  357.       the OutFile.  Hit <ENTER> on the first request to skip area code
  358.       processing.
  359.    2. State: Enter (one at a time) each 2-letter Post Office state abbreviation
  360.       you want included in the OutFile.  Again, hitting <ENTER> on the first
  361.       request skips this screening section.
  362.    3. BBS Type: Enter (all on one line) the single-letter codes for the BBS
  363.       types you want included.  Hitting <ENTER> on a blank line again skips
  364.       this section.
  365.  
  366.    If you skip all three sections, the program aborts.  Otherwise, it will
  367.    run through the Darwin file, showing you the current line count and current
  368.    OutFile entry count in the center of the screen.
  369.    This process will take some time, and if it yields too large of a file,
  370.    you will be asked to do it again... screening it a little more tightly this
  371.    time.
  372. --------------------------------------------------------------------------------
  373. --------------------------------------------------------------------------------
  374. Usage notes
  375. -----------
  376. Due to the fact that most of the processing in these programs is done
  377. in memory -- and the fact that the data segment of a Turbo Pascal program
  378. is limited to 64KB -- the largest dialing directory that Telix Tools can
  379. handle is 710 entries.  If you have more than that, consider splitting the
  380. directory into two or more smaller ones.  If enough registered users ask,
  381. I'll write a program to do just that.
  382.  
  383. You can abort the programs (using Ctrl-Break or Ctrl-C, whichever usually works
  384. with Turbo Pascal programs) at any time before you get a "Writing FILENAME.FON"
  385. message without losing any files.  Once the program begins writing, however,
  386. you have to let it finish... or else the output file WILL be trashed.
  387.  
  388. As always when working with data you consider important, you may wish to backup
  389. each dialing directory you process before you start.  This is to insure that
  390. (1) you don't make a fatal mistake and (2) that I didn't.  When you consider
  391. that the passwords contained in a Telix dialing directory are almost
  392. irreplaceable, you really can't be too safe.
  393.  
  394. If you're using DOS 3.00 or higher, the help screens will begin with a "command
  395. line" that shows the actual filename of the program.  This way, you can rename
  396. your program to something less finger-twisting than my names and still have
  397. a sensible help screen.  Command-line filename reading began with DOS 3.00.
  398. If you have DOS 2.11 or lower, you'll get my name for the program on your
  399. help screen instead of yours.  That's not my fault... but DOS's.  With DOS
  400. 4.0x out, it may be time to upgrade.
  401. --------------------------------------------------------------------------------
  402. Registered users
  403. ----------------
  404. If you're not yet a registered user of Telix, do that first (the information
  405. is in the Telix package).
  406.  
  407. Then, you become registered for the Telix Tools by sending $10.00 to the
  408. address shown below.  Registered users will receive support as needed,
  409. bug fixes as they are released, and notification of major changes in the
  410. Telix Tools.
  411.  
  412. At this time, no major changes are planned unless Telix 4.00 comes out.
  413. However, your registration will allow you to keep up with the Telix Tools
  414. until the next overhaul.
  415. --------------------------------------------------------------------------------
  416. Author
  417. ------
  418. Robert Hoffmann
  419. 76-53 271 Street
  420. New Hyde Park NY 11040
  421.  
  422. White Tiger BBS (my home BBS) 1-718-962-2628
  423. --------------------------------------------------------------------------------
  424. Other products by the author
  425. ----------------------------
  426. GupList  - a support program for the PCBoard door 'Card Guppies'.  It produces
  427.            a text file (bulletin) after every run of 'Guppies', so that the
  428.            game's players can check their scores without re-loading the game.
  429.  
  430. TimedAsk - a batch file program, similar to Norton's ASK, which times the
  431.            user's response and sends default results if there is no response
  432.            within the desired time.  Useful for batch files which run
  433.            unattended... sometimes.
  434. --------------------------------------------------------------------------------
  435. Release history
  436. ---------------
  437. Version   Date      What it did
  438. -------   ----      -----------
  439.   1.0     11/28/88  First public release.
  440.  
  441. Program and documentation (C) 1988 Robert Hoffmann.
  442. Telix 3.11 (and earlier versions) (C) 1988 Exis Inc. and Colin Sampaleanu.
  443. Turbo Pascal 5.0 (C) 1983-88 Borland Inc.
  444. PKPAK 3.61 (C) 1986-88 PKWare Inc.
  445. LIST 6.4A (C) 1983-88 Vernon Buerg.
  446.  
  447. Documentation updated as of Mon  11-28-1988   1:01 pm.
  448.